@types/puppeteer

What is @types/puppeteer?

@types/puppeteer provides TypeScript type definitions for the Puppeteer library, which is a Node library that provides a high-level API to control headless Chrome or Chromium over the DevTools Protocol. It can also be configured to use full (non-headless) Chrome or Chromium.

What are @types/puppeteer's main functionalities?

Launching a Browser

This feature allows you to launch a new browser instance, open a new page, navigate to a URL, and then close the browser.

const puppeteer = require('puppeteer');
(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  await browser.close();
})();

Taking a Screenshot

This feature allows you to take a screenshot of a webpage. The screenshot is saved to a file specified by the 'path' option.

const puppeteer = require('puppeteer');
(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  await page.screenshot({ path: 'example.png' });
  await browser.close();
})();

Generating a PDF

This feature allows you to generate a PDF of a webpage. The PDF is saved to a file specified by the 'path' option and can be formatted using various options.

const puppeteer = require('puppeteer');
(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  await page.pdf({ path: 'example.pdf', format: 'A4' });
  await browser.close();
})();

Scraping Content

This feature allows you to scrape content from a webpage. The example code navigates to a URL and logs the text content of the page.

const puppeteer = require('puppeteer');
(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  const content = await page.evaluate(() => document.body.textContent);
  console.log(content);
  await browser.close();
})();

Automating Form Submission

This feature allows you to automate form submission. The example code navigates to a form page, fills out the form fields, submits the form, and waits for the navigation to complete.

const puppeteer = require('puppeteer');
(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com/form');
  await page.type('#name', 'John Doe');
  await page.type('#email', '[e-mail]');
  await page.click('#submit');
  await page.waitForNavigation();
  await browser.close();
})();

Other packages similar to @types/puppeteer

playwright

Playwright is a Node library to automate Chromium, Firefox, and WebKit with a single API. It is similar to Puppeteer but supports multiple browsers and provides more advanced features for browser automation.

selenium-webdriver

Selenium WebDriver is a popular tool for automating web applications for testing purposes. It supports multiple programming languages and browsers, making it a versatile choice for browser automation.

nightwatch

Nightwatch is an integrated, easy-to-use End-to-End testing solution for web applications and websites, written in Node.js. It uses the W3C WebDriver API to perform commands and assertions on DOM elements.

cypress

Cypress is a JavaScript end-to-end testing framework that aims to make testing fast, easy, and reliable. It provides a rich set of features for writing and running tests, including time travel, real-time reloads, and automatic waiting.

README

Installation

npm install --save @types/puppeteer

Summary

This package contains type definitions for puppeteer (https://github.com/GoogleChrome/puppeteer#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/puppeteer.

Additional Details

• Last updated: Wed, 12 Oct 2022 19:03:13 GMT
• Dependencies: @types/node
• Global values: none

Credits

These definitions were written by Marvin Hagemeister, Christopher Deutsch, Konstantin Simon Maria Möllers, Simon Schick, Serban Ghita, Jason Kaczmarsky, Dave Cardwell, Andrés Ortiz, Piotr Błażejewicz, Cameron Hunter, and Pirasis Leelatanon.